#OriginSearchExam

Notification before use

Depending on the type of product you are using, the definitions of ‘Parameter’, ‘IO Logic’, ‘AxisStatus’, etc. may be different. This example is based on ‘Ezi-SERVO’, so please apply the appropriate value depending on the product you are using.

Example)    

FM_EZISERVO_PARAM           // Parameter enum when using 'Ezi-SERVO'    
FM_EZIMOTIONLINK_PARAM      // Parameter enum when using 'Ezi-MOTIONLINK'

[EN]
This example code is implemented to run on Python 3.x and later. If you use version 3.0 or less, you need to change the print and input functions.

[KR]
이 예제코드는 파이썬 3.x이상에서 동작하도록 구현되어있습니다. 3.0이하 버전에서 사용하실경우 print, input함수의 변형이 필요합니다.

0. Program scenario

[EN]
1. Connect a device. 2. Check the drive error. 3. Enable Servo. 4. Configure the parameters related to the origin search. 5. Search the motor origin. 6. Close connection.

[KR]
1. 장치 연결. 2. 드라이브 에러 체크. 3. Servo Enable. 4. 원점 탐색 관련 파라미터 설정. 5. 모터 원점 탐색 실시. 6. 연결 해제.

1. Setting the Path

import sys
import os
import platform
try:
    include_path = os.path.abspath(
        os.path.join(os.path.dirname(__file__), "..")
    )
except NameError:
    include_path = os.path.abspath(
        os.path.join(os.getcwd(), "..")
    )

arch = platform.architecture()[0]
if arch == '64bit':
    library_path = os.path.join(include_path, "Include_Python_x64")
else:
    library_path = os.path.join(include_path, "Include_Python")

sys.path.append(library_path)

[EN]
This code adds the appropriate Library folder path according to the Python architecture to import FAS_EziMOTIONPlusE, MOTION_DEFINE, and ReturnCodes_Define modules. If the Library folder is in a different path, enter that path in Library_path.

[KR]
FAS_EziMOTIONPlusE, MOTION_DEFINE, ReturnCodes_Define 모듈들을 Import 하기 위하여 파이썬 아키텍쳐에 따라 알맞은 Library 폴더 경로를 추가하는 코드입니다. Library 폴더가 다른 경로에 있는 경우, library_path에 해당 경로를 입력해 주시기 바랍니다.

2. Check drive error

# Check Drive's Error
status_result, axis_status = FAS_GetAxisStatus(nPortNo, iSlaveNo)

if status_result != FMM_OK:
    print("Function(FAS_GetAxisStatus) was failed.")
    return False

if axis_status & EZISERVO_AXISSTATUS.FFLAG_ERRORALL:
    # if Drive's Error was detected, Reset the ServoAlarm
    if FAS_ServoAlarmReset(nPortNo, iSlaveNo) != FMM_OK:
        print("Function(FAS_ServoAlarmReset) was failed.")
        return False

[EN]
You can check the current drive’s operating status using the FAS_GetAxisStatus() function. You can reset the current drive’s alarm status using the FAS_ServoAlarmReset() function.

[KR]
FAS_GetAxisStatus() 함수를 사용하여 현재 드라이브의 운전 상태를 확인 할 수 있습니다. FAS_ServoAlarmReset() 함수를 사용하여 현재 드라이브의 알람상태를 리셋 할 수 있습니다.

2.1 Axis status

[EN]
EZISERVO_AXISSTATUS is a structure that organizes drive status values. It can be checked in the define file (MOTION_EziSERVO_DEFINE.py).

[KR]
EZISERVO_AXISSTATUS 는 드라이브 상태값이 정리된 구조체이며 define파일 (MOTION_EziSERVO_DEFINE.py)에서 확인하실 수 있습니다.

3. Servo Enable

if FAS_ServoEnable(nPortNo, iSlaveNo, 1) != FMM_OK:
        print("Function(FAS_ServoEnable) was failed.")
        return False

[EN]
You can set the Servo Enable signal of the drive using the FAS_ServoEnable() function.

[KR]
FAS_ServoEnable() 함수를 사용하여 드라이브의 Servo Enable 신호를 설정할 수 있습니다.

4. Set parameter value

if FAS_SetParameter(nPortNo, iSlaveNo, SERVO_ORGSPEED, nOrgSpeed) != FMM_OK:
    print("Function(FAS_SetParameter[SERVO_ORGSPEED]) was failed.")
    return False

if (
    FAS_SetParameter(nPortNo, iSlaveNo, SERVO_ORGSEARCHSPEED, nOrgSearchSpeed)
    != FMM_OK
):
    print("Function(FAS_SetParameter[SERVO_ORGSEARCHSPEED]) was failed.")
    return False

if (
    FAS_SetParameter(nPortNo, iSlaveNo, SERVO_ORGACCDECTIME, nOrgAccDecTime)
    != FMM_OK
):
    print("Function(FAS_SetParameter[SERVO_ORGACCDECTIME]) was failed.")
    return False

if FAS_SetParameter(nPortNo, iSlaveNo, SERVO_ORGMETHOD, nOrgMethod) != FMM_OK:
    print("Function(FAS_SetParameter[SERVO_ORGMETHOD]) was failed.")
    return False

if FAS_SetParameter(nPortNo, iSlaveNo, SERVO_ORGDIR, nOrgDir) != FMM_OK:
    print("Function(FAS_SetParameter[SERVO_ORGDIR]) was failed.")
    return False

if FAS_SetParameter(nPortNo, iSlaveNo, SERVO_ORGOFFSET, nOrgOffset) != FMM_OK:
    print("Function(FAS_SetParameter[SERVO_ORGOFFSET]) was failed.")
    return False

if (
    FAS_SetParameter(nPortNo, iSlaveNo, SERVO_ORGPOSITIONSET, nOrgPositionSet)
    != FMM_OK
):
    print("Function(FAS_SetParameter[SERVO_ORGPOSITIONSET]) was failed.")
    return False

if (
    FAS_SetParameter(nPortNo, iSlaveNo, SERVO_ORGTORQUERATIO, nOrgTorqueRatio)
    != FMM_OK
):
    print("Function(FAS_SetParameter[SERVO_ORGTORQUERATIO]) was failed.")
    return False

[EN]
You can change the parameter value using the ‘FAS_SetParameter’ function. The parameter value takes effect immediately after it is set.

[KR]
FAS_SetParameter 함수를 사용하여 파라미터의 값을 변경할 수 있습니다. 파라미터의 값은 설정하는 즉시 적용됩니다.

4.1 Origin method

[EN]
There are the various parameter numbers about origin search, such as SERVO_ORGSPEED, SERVO_ORGSEARCHSPEED, SERVO_ORGACCDECTIME, etc. You can check those parameter numbers in the corresponding define file (MOTION_SERVO_DEFINE.py for Ezi-SERVO Plus-R). Or, refer to the number displayed on the Parameter List screen of the Ezi-MOTION Plus-R program.

[KR]
SERVO_ORGSPEED, SERVO_ORGSEARCHSPEED, SERVO_ORGACCDECTIME… 다양한 원점 탐색에 대한 설정값 파라미터 번호입니다. 설정하고자 하는 파라미터의 번호는 해당하는 define 파일(Ezi-SERVO Plus-R의 경우 MOTION_SERVO_DEFINE.py)에서 확인하실 수 있습니다. 혹은, Ezi-MOTION Plus-R 프로그램의 Parameter List 화면에 표시되는 번호를 참고하시기 바랍니다.

5. Move origin

# Origin Search Start
if FAS_MoveOriginSingleAxis(nPortNo, iSlaveNo) != FMM_OK:
    print("Function(FAS_MoveOriginSingleAxis) was failed.")
    return False

[EN]
FAS_MoveOriginSingleAxis() function will start origin search with the configured search mode.

[KR]
FAS_MoveOriginSingleAxis() 함수를 사용하여 사용자가 설정한 탐색 모드값에 따라 탐색이 시작됩니다.

6. Watch drive status

# Check the Axis status until OriginReturning value is released.

while True:
    time.sleep(0.001)

    status_result, axis_status = FAS_GetAxisStatus(nPortNo, iSlaveNo)
    if status_result != FMM_OK:
        print("Function(FAS_GetAxisStatus) was failed.")
        return False

    if not (axis_status & EZISERVO_AXISSTATUS.FFLAG_ORIGINRETURNING):
        break

if axis_status & EZISERVO_AXISSTATUS.FFLAG_ORIGINRETOK:
    print("Origin Search Success!")
    return True

[EN]
The FAS_GetAxisStatus() function indicates the drive status value. The user can use it to check the status and wait until a specific status value is confirmed. In addition, the user can check whether the motor origin search is completed with the values ​​FFLAG_MOTIONING (‘0’) and FFLAG_INPOSITION (‘1’).

[KR]
드라이브의 운전 상태값을 나타내는 FAS_GetAxisStatus() 함수를 사용하여 사용자가 원하는 특정상태 값이 확인 될 때까지 대기할 수 있습니다. 더하여 모터의 원점 탐색 완료 상태는 FFLAG_ORIGINRETURNING (‘0’) 및 FFLAG_ORIGINRETOK(‘1’) 값으로 확인 할 수 있습니다.

7. Etc

[EN]
1. For function descriptions on connecting and disconnecting devices, please refer to the [01.ConnectionExam] project document. 2. For function descriptions on setting parameters, please refer to the [02.ParameterTestExam] project document.

[KR]
1. 장치 연결 및 해제에 대한 함수 설명은 [01.ConnectionExam] 프로젝트 문서를 참고하시기 바랍니다. 2. 파라미터 설정에 대한 함수 설명은 [02.ParameterTestExam] 프로젝트 문서를 참고하시기 바랍니다.